<HTML><HEAD><TITLE>current_atom(?Atom)</TITLE>
</HEAD><BODY>[ <A HREF="index.html">Type Testing</A> | <A HREF="../../index.html">Reference Manual</A> | <A HREF="../../fullindex.html">Alphabetic Index</A> ]
<H1>current_atom(?Atom)</H1>
Succeeds if Atom is an atom in the system.


<DL>
<DT><EM>Atom</EM></DT>
<DD>Atom or variable.
</DD>
</DL>
<H2>Description</H2>
   Used to return all currently defined atoms.

<P>
   Note that once an atom name is specified for the first time it is
   automatically made known to the system, so calls to current_atom/1 with
   any atom as an argument will always succeed.

<P>

<H3>Modes and Determinism</H3><UL>
<LI>current_atom(+) is det
<LI>current_atom(-) is multi
</UL>
<H3>Exceptions</H3>
<DL>
<DT><EM>(5) type error </EM>
<DD>Atom is not instantiated to an atom.
</DL>
<H2>Examples</H2>
<PRE>
Success:
   current_atom(eclipse).
   current_atom(anything).
   current_atom('My atom').

   [eclipse]: current_atom(X).

   X = []    More? (;)         % RETURN pressed
   yes.
   [eclipse]:

Error:
   current_atom(1).           Error 5.
   current_atom(man(1)).      Error 5.



</PRE>
<H2>See Also</H2>
<A HREF="../../kernel/typetest/atom-1.html">atom / 1</A>, <A HREF="../../kernel/typetest/current_functor-1.html">current_functor / 1</A>
</BODY></HTML>
